| Field Name (Case–Sensitive) |
Required MandatoryOptional |
Type (max length) |
Description |
|---|---|---|---|
| PayServerUser ^ | M | String | This is the technical merchant user ID given for the VPG Admin site. |
| TransactionCompletedURL ^ | O | String(256) |
Response URL forsuccessful transactions. Overrides existing URL, if value is passed. See 3.7.3. Merchant Notification POST Fields Note, this is a synchronous HTTPS POST that happens on Form submit from the clients browser. In order to guarantee a response from the payment outcome, use the asynchronous TransactionStatusCallbackUrl to guarantee delivery |
| RedirectURL ^ | O | String(256) |
Response URL forunsuccessfultransactions. Overrides existing URL, if value is passed. See 3.7.3. Merchant Notification POST Fields Note, this is a synchronous HTTPS POST that happens on Form submit from the clients browser. In order to guarantee a response from the payment outcome, use the asynchronous TransactionStatusCallbackUrl to guarantee delivery |
| TransactionStatusCallbackUrl ^ | M | String(256) |
This is the URL to which asynchronous callbacks are sent. See 3.7.4. Asynchronous Call–back. Note, in order for this to function, firewall ports must be opened on the Payment Gateway to post–back to your server. This server–to–server post–back has built in guaranteed delivery and retry queuing until an HTTP 200 response is received from the merchant. |
| TransactionStatusCallbackFormat | O | String(4) |
This is the structure of the format in which the asynchronous callback message is sent as a URL encoded form. Permitted values (if omitted default is XML):
|
| TransactionStatusCallbackMethod | O | String(4) | This is the format in which the asynchronous callback message is sent. Permitted Values (if omitted default is GET):
|
| encXML | O | String(4) | The encrypted XML Transaction object created in Step 1 and Step 2 must be passed in this field. (Mandatory if encrypted payload is XML) |
| encJSON | O | String(4) | The encrypted JSON Transaction object created in Step 1 and Step 2 must be passed in this field. (Mandatory if encrypted payload is JSON) |
| encType | O | String(8) |
This is encryption algorithm the merchant has elected to use. Permitted Values (if omitted default value is BLOWFISH):
|
| encSalt | O | String(32) |
Random string used by merchant to salt the password used to encrypt the message passed in encXML/encJSON and used by Vodacom to decrypt the message. Mandatory if encType is TWOFISH or AES |
| encIV | O | String(16) |
Random string used by merchant used as the Initialisation Vector to encrypt the message passed in encXML/encJSON and used by Vodacom to decrypt the message. Mandatory if encType is TWOFISH or AES. |
| encIterations | O | Numeric |
Number of iterations used to derive the key (along with the salt and stored encryption key) using password-based key derivation functionality (PBKDF2). Mandatory if encType is TWOFISH or AES. |
| currency ^ | M | String(3) | Country currency. Supply the 3 character ISO currency code. (ZAR for South African Rands) |
| TransactionType | M | String(2) | This will indicate the type of transaction requested. Valid values:
|
| MerchantReference | M | String(20) | This is the unique value that is used by the Merchant to identify the transaction on his system. |
| MerchantIdentifier ^ | O | String(38) |
This is the unique identifier that is issued to the merchant by VFS to identify him on the payment platform. (This parameter is mandatory for Save Card functionality or if the data/airtime recharge service is utilised) |
| CustomerIdentifier | O/td> | String(20) |
A unique value representing the merchant's customer undertaking this payment transaction. Will be used to identify the customer if they elect to save their credit card details during payment (for future use). Mandatory if merchant has been enabled for "Save Card." See 4.7 Appendix G: Payments Page Checkout & Saved Card for further details. |
| SalesType ^ | O | String(2) | Indicates the type of telco goods being purchased. (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). Valid Values:
|
| ValidationSysTraceAuditNumber (Deprecated) |
O | Numeric |
Unique number returned from the recharge validation service to identify the recharge validation request. (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). |
| ValidationTransDateTime (Deprecated) |
O | Numeric |
Datetime stamp returned from the recharge validation service to identify the recharge validation request (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). |
| Amount (Deprecated) |
O | Decimal |
Recharge Amount. (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). |
| RegisteredMSISDN (Deprecated) |
O | Numeric |
This is the MSISDN number of the customer as registered on the merchant's platform. (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). |
| RechargeMSISDN (Deprecated) |
O | Numeric | This is the MSISDN number of the customer as registered on the merchant's platform for recharge purposes (This parameter should only be passed if the merchant intends to invoke the data/airtime recharge service). |